Replace the boilerplate README with a pointer to the docs - #20
Open
peterbjohnson wants to merge 1 commit into
Open
Replace the boilerplate README with a pointer to the docs#20peterbjohnson wants to merge 1 commit into
peterbjohnson wants to merge 1 commit into
Conversation
The README was the unmodified template from
evaluation-function-boilerplate-python. It never mentioned music, MIDI or
audio, and several parts were actively wrong:
- the release badge still contained the literal {REPO_NAME_HERE}
placeholder, so the button linked to a repository that does not exist
- the development workflow described editing evaluation_function.wl, a
Wolfram file that does not exist here
- the repository structure omitted compare_MIDI.py and audio_processing.py,
the two files holding all the logic
- the deployment section pointed at .github/workflows/deploy.yml, while
this repo has staging-deploy.yml and production-deploy.yml
- it documented a dev.py invocation that fails immediately (see #14)
- the Quickstart chapter was the template's own setup guide, which the
template says to delete once setup is done
Replace it with a short description and links to docs/user.md and
docs/dev.md, which is where the real documentation already lives, and
which the platform publishes to the central docs site.
238 lines to 49.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #15
Problem
README.mdwas the unmodified template fromevaluation-function-boilerplate-python, 238 lines that never mentioned music, MIDI or audio. Several parts were not merely generic but wrong:{REPO_NAME_HERE}placeholder, so the button linked to a repository that does not exist.evaluation_function.wl, a Wolfram file that does not exist here.compare_MIDI.pyandaudio_processing.py, the two files that hold all of the logic..github/workflows/deploy.yml; this repo hasstaging-deploy.ymlandproduction-deploy.yml.dev.pyinvocation that fails immediately (Leftover boilerplate: dev.py, preview.py, healthcheck and return annotation are all broken #14).Change
Following the convention used by
compareExpressions: a short description plus a pointer to the documentation, which already exists and is good.docs/user.mdanddocs/dev.md. Those are the files the platform fetches into the central docs site via EvalDocsLoader, so they are the canonical location.238 lines to 49.
A note on the local request shape
The README states that the container answers
POST /with acommand: evalheader. This differs from the central documentation, which gives an AWS Lambda emulator path. That page is wrong for a plaindocker run, and I have raised it separately as lambda-feedback/user-documentation#38. The shape documented here is the one verified against this image.No published docs link
compareExpressionslinks to its page on the documentation site. The equivalent URL for this function currently returns 404, presumably because it is not registered yet, so I have linked only the in-repo files rather than adding a dead link. Worth adding once it is deployed.On testing
There is no test in this PR. The change is prose, and its correctness is a human judgement rather than something to assert.
I did check mechanically that every relative link resolves, that each path named in the structure block exists, and that no template placeholders remain. One thing here is a real contract worth guarding:
docs/user.mdanddocs/dev.mdare fetched by the platform, so renaming either silently breaks the central docs site. That belongs with the other deployment-contract checks rather than in a file of its own, so I would rather fold it into the environment tests once #17 and #18 land than add a third test file now.🤖 Generated with Claude Code